<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="datamigration_v1.html">Database Migration API</a> . <a href="datamigration_v1.projects.html">projects</a> . <a href="datamigration_v1.projects.locations.html">locations</a> . <a href="datamigration_v1.projects.locations.migrationJobs.html">migrationJobs</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="datamigration_v1.projects.locations.migrationJobs.objects.html">objects()</a></code>
</p>
<p class="firstline">Returns the objects Resource.</p>

<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, migrationJobId=None, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new migration job in a given project and location.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, force=None, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a single migration job.</p>
<p class="toc_element">
  <code><a href="#demoteDestination">demoteDestination(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Demotes the destination database to become a read replica of the source. This is applicable for the following migrations: 1. MySQL to Cloud SQL for MySQL 2. PostgreSQL to Cloud SQL for PostgreSQL 3. PostgreSQL to AlloyDB for PostgreSQL.</p>
<p class="toc_element">
  <code><a href="#fetchSourceObjects">fetchSourceObjects(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves objects from the source database that can be selected for data migration. This is applicable for the following migrations: 1. PostgreSQL to Cloud SQL for PostgreSQL 2. PostgreSQL to AlloyDB for PostgreSQL.</p>
<p class="toc_element">
  <code><a href="#generateSshScript">generateSshScript(migrationJob, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Generate a SSH configuration script to configure the reverse SSH connectivity.</p>
<p class="toc_element">
  <code><a href="#generateTcpProxyScript">generateTcpProxyScript(migrationJob, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Generate a TCP Proxy configuration script to configure a cloud-hosted VM running a TCP Proxy.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single migration job.</p>
<p class="toc_element">
  <code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists migration jobs in a given project and location.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the parameters of a single migration job.</p>
<p class="toc_element">
  <code><a href="#promote">promote(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Promote a migration job, stopping replication to the destination and promoting the destination to be a standalone database.</p>
<p class="toc_element">
  <code><a href="#restart">restart(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Restart a stopped or failed migration job, resetting the destination instance to its original state and starting the migration process from scratch.</p>
<p class="toc_element">
  <code><a href="#resume">resume(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Resume a migration job that is currently stopped and is resumable (was stopped during CDC phase).</p>
<p class="toc_element">
  <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.</p>
<p class="toc_element">
  <code><a href="#start">start(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Start an already created migration job.</p>
<p class="toc_element">
  <code><a href="#stop">stop(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Stops a running migration job.</p>
<p class="toc_element">
  <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>
<p class="toc_element">
  <code><a href="#verify">verify(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Verify a migration job, making sure the destination can reach the source and that all configuration and prerequisites are met.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, migrationJobId=None, requestId=None, x__xgafv=None)</code>
  <pre>Creates a new migration job in a given project and location.

Args:
  parent: string, Required. The parent which owns this collection of migration jobs. (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents a Database Migration Service migration job object.
  &quot;cmekKeyName&quot;: &quot;A String&quot;, # The CMEK (customer-managed encryption key) fully qualified key name used for the migration job. This field supports all migration jobs types except for: * Mysql to Mysql (use the cmek field in the cloudsql connection profile instead). * PostrgeSQL to PostgreSQL (use the cmek field in the cloudsql connection profile instead). * PostgreSQL to AlloyDB (use the kms_key_name field in the alloydb connection profile instead). Each Cloud CMEK key has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
  &quot;conversionWorkspace&quot;: { # A conversion workspace&#x27;s version. # The conversion workspace used by the migration.
    &quot;commitId&quot;: &quot;A String&quot;, # The commit ID of the conversion workspace.
    &quot;name&quot;: &quot;A String&quot;, # The resource name (URI) of the conversion workspace.
  },
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC &quot;Zulu&quot; format, accurate to nanoseconds. Example: &quot;2014-10-02T15:01:23.045123456Z&quot;.
  &quot;destination&quot;: &quot;A String&quot;, # Required. The resource name (URI) of the destination connection profile.
  &quot;destinationDatabase&quot;: { # A message defining the database engine and provider. # The database engine type and provider of the destination.
    &quot;engine&quot;: &quot;A String&quot;, # The database engine.
    &quot;provider&quot;: &quot;A String&quot;, # The database provider.
  },
  &quot;displayName&quot;: &quot;A String&quot;, # The migration job display name.
  &quot;dumpFlags&quot;: { # Dump flags definition. # The initial dump flags. This field and the &quot;dump_path&quot; field are mutually exclusive.
    &quot;dumpFlags&quot;: [ # The flags for the initial dump.
      { # Dump flag definition.
        &quot;name&quot;: &quot;A String&quot;, # The name of the flag
        &quot;value&quot;: &quot;A String&quot;, # The value of the flag.
      },
    ],
  },
  &quot;dumpPath&quot;: &quot;A String&quot;, # The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). This field and the &quot;dump_flags&quot; field are mutually exclusive.
  &quot;dumpType&quot;: &quot;A String&quot;, # Optional. The type of the data dump. Supported for MySQL to CloudSQL for MySQL migrations only.
  &quot;duration&quot;: &quot;A String&quot;, # Output only. The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by &#x27;s&#x27;. Example: &quot;3.5s&quot;.
  &quot;endTime&quot;: &quot;A String&quot;, # Output only. If the migration job is completed, the time when it was completed.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error details in case of state FAILED.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;filter&quot;: &quot;A String&quot;, # This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace.
  &quot;labels&quot;: { # The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of &quot;key&quot;: &quot;value&quot; pairs. Example: `{ &quot;name&quot;: &quot;wrench&quot;, &quot;mass&quot;: &quot;1.3kg&quot;, &quot;count&quot;: &quot;3&quot; }`.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;name&quot;: &quot;A String&quot;, # The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
  &quot;objectsConfig&quot;: { # Configuration for the objects to be migrated. # Optional. The objects that need to be migrated.
    &quot;sourceObjectsConfig&quot;: { # List of configurations for the source objects to be migrated. # The list of the migration job objects.
      &quot;objectConfigs&quot;: [ # Optional. The list of the objects to be migrated.
        { # Config for a single migration job object.
          &quot;objectIdentifier&quot;: { # An identifier for the Migration Job Object. # Optional. The object identifier.
            &quot;database&quot;: &quot;A String&quot;, # Optional. The database name. This will be required only if the object uses a database name as part of its unique identifier.
            &quot;schema&quot;: &quot;A String&quot;, # Optional. The schema name. This will be required only if the object uses a schema name as part of its unique identifier.
            &quot;table&quot;: &quot;A String&quot;, # Optional. The table name. This will be required only if the object is a level below database or schema.
            &quot;type&quot;: &quot;A String&quot;, # Required. The type of the migration job object.
          },
        },
      ],
      &quot;objectsSelectionType&quot;: &quot;A String&quot;, # Optional. The objects selection type of the migration job.
    },
  },
  &quot;oracleToPostgresConfig&quot;: { # Configuration for heterogeneous **Oracle to Cloud SQL for PostgreSQL** and **Oracle to AlloyDB for PostgreSQL** migrations. # Configuration for heterogeneous **Oracle to Cloud SQL for PostgreSQL** and **Oracle to AlloyDB for PostgreSQL** migrations.
    &quot;oracleSourceConfig&quot;: { # Configuration for Oracle as a source in a migration. # Optional. Configuration for Oracle source.
      &quot;binaryLogParser&quot;: { # Configuration to use Binary Log Parser CDC technique. # Use Binary Log Parser.
        &quot;logFileDirectories&quot;: { # Configuration to specify the Oracle directories to access the log files. # Use Oracle directories.
          &quot;archivedLogDirectory&quot;: &quot;A String&quot;, # Required. Oracle directory for archived logs.
          &quot;onlineLogDirectory&quot;: &quot;A String&quot;, # Required. Oracle directory for online logs.
        },
        &quot;oracleAsmLogFileAccess&quot;: { # Configuration to use Oracle ASM to access the log files. # Use Oracle ASM.
        },
      },
      &quot;cdcStartPosition&quot;: &quot;A String&quot;, # Optional. The schema change number (SCN) to start CDC data migration from.
      &quot;logMiner&quot;: { # Configuration to use LogMiner CDC method. # Use LogMiner.
      },
      &quot;maxConcurrentCdcConnections&quot;: 42, # Optional. Maximum number of connections Database Migration Service will open to the source for CDC phase.
      &quot;maxConcurrentFullDumpConnections&quot;: 42, # Optional. Maximum number of connections Database Migration Service will open to the source for full dump phase.
      &quot;skipFullDump&quot;: True or False, # Optional. Whether to skip full dump or not.
    },
    &quot;postgresDestinationConfig&quot;: { # Configuration for Postgres as a destination in a migration. # Optional. Configuration for Postgres destination.
      &quot;maxConcurrentConnections&quot;: 42, # Optional. Maximum number of connections Database Migration Service will open to the destination for data migration.
      &quot;transactionTimeout&quot;: &quot;A String&quot;, # Optional. Timeout for data migration transactions.
    },
  },
  &quot;performanceConfig&quot;: { # Performance configuration definition. # Optional. Data dump parallelism settings used by the migration.
    &quot;dumpParallelLevel&quot;: &quot;A String&quot;, # Initial dump parallelism level.
  },
  &quot;phase&quot;: &quot;A String&quot;, # Output only. The current migration job phase.
  &quot;reverseSshConnectivity&quot;: { # The details needed to configure a reverse SSH tunnel between the source and destination databases. These details will be used when calling the generateSshScript method (see https://cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.migrationJobs/generateSshScript) to produce the script that will help set up the reverse SSH tunnel, and to set up the VPC peering between the Cloud SQL private network and the VPC. # The details needed to communicate to the source over Reverse SSH tunnel connectivity.
    &quot;vm&quot;: &quot;A String&quot;, # The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
    &quot;vmIp&quot;: &quot;A String&quot;, # Required. The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
    &quot;vmPort&quot;: 42, # Required. The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
    &quot;vpc&quot;: &quot;A String&quot;, # The name of the VPC to peer with the Cloud SQL private network.
  },
  &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
  &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
  &quot;source&quot;: &quot;A String&quot;, # Required. The resource name (URI) of the source connection profile.
  &quot;sourceDatabase&quot;: { # A message defining the database engine and provider. # The database engine type and provider of the source.
    &quot;engine&quot;: &quot;A String&quot;, # The database engine.
    &quot;provider&quot;: &quot;A String&quot;, # The database provider.
  },
  &quot;sqlserverHomogeneousMigrationJobConfig&quot;: { # Configuration for homogeneous migration to Cloud SQL for SQL Server. # Optional. Configuration for SQL Server homogeneous migration.
    &quot;backupFilePattern&quot;: &quot;A String&quot;, # Required. Pattern that describes the default backup naming strategy. The specified pattern should ensure lexicographical order of backups. The pattern must define one of the following capture group sets: Capture group set #1 yy/yyyy - year, 2 or 4 digits mm - month number, 1-12 dd - day of month, 1-31 hh - hour of day, 00-23 mi - minutes, 00-59 ss - seconds, 00-59 Example: For backup file TestDB_20230802_155400.trn, use pattern: (?.*)_backup_(?\d{4})(?\d{2})(?\d{2})_(?\d{2})(?\d{2})(?\d{2}).trn Capture group set #2 timestamp - unix timestamp Example: For backup file TestDB.1691448254.trn, use pattern: (?.*)\.(?\d*).trn or (?.*)\.(?\d*).trn
    &quot;dagConfig&quot;: { # Configuration for distributed availability group (DAG) for the SQL Server homogeneous migration. # Optional. Configuration for distributed availability group (DAG) for the SQL Server homogeneous migration.
      &quot;linkedServer&quot;: &quot;A String&quot;, # Required. The name of the linked server that points to the source SQL Server instance. Only used by DAG migrations.
      &quot;sourceAg&quot;: &quot;A String&quot;, # Required. The name of the source availability group. Only used by DAG migrations.
    },
    &quot;databaseBackups&quot;: [ # Required. Backup details per database in Cloud Storage.
      { # Specifies the backup details for a single database in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server.
        &quot;database&quot;: &quot;A String&quot;, # Required. Name of a SQL Server database for which to define backup configuration.
        &quot;encryptionOptions&quot;: { # Encryption settings for the SQL Server database. # Optional. Encryption settings for the database. Required if provided database backups are encrypted. Encryption settings include path to certificate, path to certificate private key, and key password.
          &quot;certPath&quot;: &quot;A String&quot;, # Required. Path to the Certificate (.cer) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.
          &quot;pvkPassword&quot;: &quot;A String&quot;, # Required. Input only. Password that encrypts the private key.
          &quot;pvkPath&quot;: &quot;A String&quot;, # Required. Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.
        },
      },
    ],
    &quot;promoteWhenReady&quot;: True or False, # Optional. Promote databases when ready.
    &quot;useDiffBackup&quot;: True or False, # Optional. Enable differential backups.
  },
  &quot;sqlserverToPostgresConfig&quot;: { # Configuration for heterogeneous **SQL Server to Cloud SQL for PostgreSQL** migrations. # Configuration for heterogeneous **SQL Server to Cloud SQL for PostgreSQL** migrations.
    &quot;postgresDestinationConfig&quot;: { # Configuration for Postgres as a destination in a migration. # Optional. Configuration for Postgres destination.
      &quot;maxConcurrentConnections&quot;: 42, # Optional. Maximum number of connections Database Migration Service will open to the destination for data migration.
      &quot;transactionTimeout&quot;: &quot;A String&quot;, # Optional. Timeout for data migration transactions.
    },
    &quot;sqlserverSourceConfig&quot;: { # Configuration for SQL Server as a source in a migration. # Optional. Configuration for SQL Server source.
      &quot;cdcStartPosition&quot;: &quot;A String&quot;, # Optional. The log sequence number (LSN) to start CDC data migration from.
      &quot;maxConcurrentCdcConnections&quot;: 42, # Optional. Maximum number of connections Database Migration Service will open to the source for CDC phase.
      &quot;maxConcurrentFullDumpConnections&quot;: 42, # Optional. Maximum number of connections Database Migration Service will open to the source for full dump phase.
      &quot;skipFullDump&quot;: True or False, # Optional. Whether to skip full dump or not.
    },
  },
  &quot;state&quot;: &quot;A String&quot;, # The current migration job state.
  &quot;staticIpConnectivity&quot;: { # The source database will allow incoming connections from the public IP of the destination database. You can retrieve the public IP of the Cloud SQL instance from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required. # static ip connectivity data (default, no additional details needed).
  },
  &quot;type&quot;: &quot;A String&quot;, # Required. The migration job type.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC &quot;Zulu&quot; format, accurate to nanoseconds. Example: &quot;2014-10-02T15:01:23.045123456Z&quot;.
  &quot;vpcPeeringConnectivity&quot;: { # The details of the VPC where the source database is located in Google Cloud. We will use this information to set up the VPC peering connection between Cloud SQL and this VPC. # The details of the VPC network that the source database is located in.
    &quot;vpc&quot;: &quot;A String&quot;, # The name of the VPC network to peer with the Cloud SQL private network.
  },
}

  migrationJobId: string, Required. The ID of the instance to create.
  requestId: string, Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, force=None, requestId=None, x__xgafv=None)</code>
  <pre>Deletes a single migration job.

Args:
  name: string, Required. Name of the migration job resource to delete. (required)
  force: boolean, The destination CloudSQL connection profile is always deleted with the migration job. In case of force delete, the destination CloudSQL replica database is also deleted.
  requestId: string, A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="demoteDestination">demoteDestination(name, body=None, x__xgafv=None)</code>
  <pre>Demotes the destination database to become a read replica of the source. This is applicable for the following migrations: 1. MySQL to Cloud SQL for MySQL 2. PostgreSQL to Cloud SQL for PostgreSQL 3. PostgreSQL to AlloyDB for PostgreSQL.

Args:
  name: string, Name of the migration job resource to demote its destination. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for &#x27;DemoteDestination&#x27; request.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="fetchSourceObjects">fetchSourceObjects(name, x__xgafv=None)</code>
  <pre>Retrieves objects from the source database that can be selected for data migration. This is applicable for the following migrations: 1. PostgreSQL to Cloud SQL for PostgreSQL 2. PostgreSQL to AlloyDB for PostgreSQL.

Args:
  name: string, Required. The resource name for the migration job for which source objects should be returned. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="generateSshScript">generateSshScript(migrationJob, body=None, x__xgafv=None)</code>
  <pre>Generate a SSH configuration script to configure the reverse SSH connectivity.

Args:
  migrationJob: string, Name of the migration job resource to generate the SSH script. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for &#x27;GenerateSshScript&#x27; request.
  &quot;vm&quot;: &quot;A String&quot;, # Required. Bastion VM Instance name to use or to create.
  &quot;vmCreationConfig&quot;: { # VM creation configuration message # The VM creation configuration
    &quot;subnet&quot;: &quot;A String&quot;, # The subnet name the vm needs to be created in.
    &quot;vmMachineType&quot;: &quot;A String&quot;, # Required. VM instance machine type to create.
    &quot;vmZone&quot;: &quot;A String&quot;, # The Google Cloud Platform zone to create the VM in.
  },
  &quot;vmPort&quot;: 42, # The port that will be open on the bastion host.
  &quot;vmSelectionConfig&quot;: { # VM selection configuration message # The VM selection configuration
    &quot;vmZone&quot;: &quot;A String&quot;, # Required. The Google Cloud Platform zone the VM is located.
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for &#x27;GenerateSshScript&#x27; request.
  &quot;script&quot;: &quot;A String&quot;, # The ssh configuration script.
}</pre>
</div>

<div class="method">
    <code class="details" id="generateTcpProxyScript">generateTcpProxyScript(migrationJob, body=None, x__xgafv=None)</code>
  <pre>Generate a TCP Proxy configuration script to configure a cloud-hosted VM running a TCP Proxy.

Args:
  migrationJob: string, Name of the migration job resource to generate the TCP Proxy script. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for &#x27;GenerateTcpProxyScript&#x27; request.
  &quot;vmMachineType&quot;: &quot;A String&quot;, # Required. The type of the Compute instance that will host the proxy.
  &quot;vmName&quot;: &quot;A String&quot;, # Required. The name of the Compute instance that will host the proxy.
  &quot;vmSubnet&quot;: &quot;A String&quot;, # Required. The name of the subnet the Compute instance will use for private connectivity. Must be supplied in the form of projects/{project}/regions/{region}/subnetworks/{subnetwork}. Note: the region for the subnet must match the Compute instance region.
  &quot;vmZone&quot;: &quot;A String&quot;, # Optional. The Google Cloud Platform zone to create the VM in. The fully qualified name of the zone must be specified, including the region name, for example &quot;us-central1-b&quot;. If not specified, uses the &quot;-b&quot; zone of the destination Connection Profile&#x27;s region.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for &#x27;GenerateTcpProxyScript&#x27; request.
  &quot;script&quot;: &quot;A String&quot;, # The TCP Proxy configuration script.
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Gets details of a single migration job.

Args:
  name: string, Required. Name of the migration job resource to get. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a Database Migration Service migration job object.
  &quot;cmekKeyName&quot;: &quot;A String&quot;, # The CMEK (customer-managed encryption key) fully qualified key name used for the migration job. This field supports all migration jobs types except for: * Mysql to Mysql (use the cmek field in the cloudsql connection profile instead). * PostrgeSQL to PostgreSQL (use the cmek field in the cloudsql connection profile instead). * PostgreSQL to AlloyDB (use the kms_key_name field in the alloydb connection profile instead). Each Cloud CMEK key has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
  &quot;conversionWorkspace&quot;: { # A conversion workspace&#x27;s version. # The conversion workspace used by the migration.
    &quot;commitId&quot;: &quot;A String&quot;, # The commit ID of the conversion workspace.
    &quot;name&quot;: &quot;A String&quot;, # The resource name (URI) of the conversion workspace.
  },
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC &quot;Zulu&quot; format, accurate to nanoseconds. Example: &quot;2014-10-02T15:01:23.045123456Z&quot;.
  &quot;destination&quot;: &quot;A String&quot;, # Required. The resource name (URI) of the destination connection profile.
  &quot;destinationDatabase&quot;: { # A message defining the database engine and provider. # The database engine type and provider of the destination.
    &quot;engine&quot;: &quot;A String&quot;, # The database engine.
    &quot;provider&quot;: &quot;A String&quot;, # The database provider.
  },
  &quot;displayName&quot;: &quot;A String&quot;, # The migration job display name.
  &quot;dumpFlags&quot;: { # Dump flags definition. # The initial dump flags. This field and the &quot;dump_path&quot; field are mutually exclusive.
    &quot;dumpFlags&quot;: [ # The flags for the initial dump.
      { # Dump flag definition.
        &quot;name&quot;: &quot;A String&quot;, # The name of the flag
        &quot;value&quot;: &quot;A String&quot;, # The value of the flag.
      },
    ],
  },
  &quot;dumpPath&quot;: &quot;A String&quot;, # The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). This field and the &quot;dump_flags&quot; field are mutually exclusive.
  &quot;dumpType&quot;: &quot;A String&quot;, # Optional. The type of the data dump. Supported for MySQL to CloudSQL for MySQL migrations only.
  &quot;duration&quot;: &quot;A String&quot;, # Output only. The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by &#x27;s&#x27;. Example: &quot;3.5s&quot;.
  &quot;endTime&quot;: &quot;A String&quot;, # Output only. If the migration job is completed, the time when it was completed.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error details in case of state FAILED.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;filter&quot;: &quot;A String&quot;, # This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace.
  &quot;labels&quot;: { # The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of &quot;key&quot;: &quot;value&quot; pairs. Example: `{ &quot;name&quot;: &quot;wrench&quot;, &quot;mass&quot;: &quot;1.3kg&quot;, &quot;count&quot;: &quot;3&quot; }`.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;name&quot;: &quot;A String&quot;, # The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
  &quot;objectsConfig&quot;: { # Configuration for the objects to be migrated. # Optional. The objects that need to be migrated.
    &quot;sourceObjectsConfig&quot;: { # List of configurations for the source objects to be migrated. # The list of the migration job objects.
      &quot;objectConfigs&quot;: [ # Optional. The list of the objects to be migrated.
        { # Config for a single migration job object.
          &quot;objectIdentifier&quot;: { # An identifier for the Migration Job Object. # Optional. The object identifier.
            &quot;database&quot;: &quot;A String&quot;, # Optional. The database name. This will be required only if the object uses a database name as part of its unique identifier.
            &quot;schema&quot;: &quot;A String&quot;, # Optional. The schema name. This will be required only if the object uses a schema name as part of its unique identifier.
            &quot;table&quot;: &quot;A String&quot;, # Optional. The table name. This will be required only if the object is a level below database or schema.
            &quot;type&quot;: &quot;A String&quot;, # Required. The type of the migration job object.
          },
        },
      ],
      &quot;objectsSelectionType&quot;: &quot;A String&quot;, # Optional. The objects selection type of the migration job.
    },
  },
  &quot;oracleToPostgresConfig&quot;: { # Configuration for heterogeneous **Oracle to Cloud SQL for PostgreSQL** and **Oracle to AlloyDB for PostgreSQL** migrations. # Configuration for heterogeneous **Oracle to Cloud SQL for PostgreSQL** and **Oracle to AlloyDB for PostgreSQL** migrations.
    &quot;oracleSourceConfig&quot;: { # Configuration for Oracle as a source in a migration. # Optional. Configuration for Oracle source.
      &quot;binaryLogParser&quot;: { # Configuration to use Binary Log Parser CDC technique. # Use Binary Log Parser.
        &quot;logFileDirectories&quot;: { # Configuration to specify the Oracle directories to access the log files. # Use Oracle directories.
          &quot;archivedLogDirectory&quot;: &quot;A String&quot;, # Required. Oracle directory for archived logs.
          &quot;onlineLogDirectory&quot;: &quot;A String&quot;, # Required. Oracle directory for online logs.
        },
        &quot;oracleAsmLogFileAccess&quot;: { # Configuration to use Oracle ASM to access the log files. # Use Oracle ASM.
        },
      },
      &quot;cdcStartPosition&quot;: &quot;A String&quot;, # Optional. The schema change number (SCN) to start CDC data migration from.
      &quot;logMiner&quot;: { # Configuration to use LogMiner CDC method. # Use LogMiner.
      },
      &quot;maxConcurrentCdcConnections&quot;: 42, # Optional. Maximum number of connections Database Migration Service will open to the source for CDC phase.
      &quot;maxConcurrentFullDumpConnections&quot;: 42, # Optional. Maximum number of connections Database Migration Service will open to the source for full dump phase.
      &quot;skipFullDump&quot;: True or False, # Optional. Whether to skip full dump or not.
    },
    &quot;postgresDestinationConfig&quot;: { # Configuration for Postgres as a destination in a migration. # Optional. Configuration for Postgres destination.
      &quot;maxConcurrentConnections&quot;: 42, # Optional. Maximum number of connections Database Migration Service will open to the destination for data migration.
      &quot;transactionTimeout&quot;: &quot;A String&quot;, # Optional. Timeout for data migration transactions.
    },
  },
  &quot;performanceConfig&quot;: { # Performance configuration definition. # Optional. Data dump parallelism settings used by the migration.
    &quot;dumpParallelLevel&quot;: &quot;A String&quot;, # Initial dump parallelism level.
  },
  &quot;phase&quot;: &quot;A String&quot;, # Output only. The current migration job phase.
  &quot;reverseSshConnectivity&quot;: { # The details needed to configure a reverse SSH tunnel between the source and destination databases. These details will be used when calling the generateSshScript method (see https://cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.migrationJobs/generateSshScript) to produce the script that will help set up the reverse SSH tunnel, and to set up the VPC peering between the Cloud SQL private network and the VPC. # The details needed to communicate to the source over Reverse SSH tunnel connectivity.
    &quot;vm&quot;: &quot;A String&quot;, # The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
    &quot;vmIp&quot;: &quot;A String&quot;, # Required. The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
    &quot;vmPort&quot;: 42, # Required. The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
    &quot;vpc&quot;: &quot;A String&quot;, # The name of the VPC to peer with the Cloud SQL private network.
  },
  &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
  &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
  &quot;source&quot;: &quot;A String&quot;, # Required. The resource name (URI) of the source connection profile.
  &quot;sourceDatabase&quot;: { # A message defining the database engine and provider. # The database engine type and provider of the source.
    &quot;engine&quot;: &quot;A String&quot;, # The database engine.
    &quot;provider&quot;: &quot;A String&quot;, # The database provider.
  },
  &quot;sqlserverHomogeneousMigrationJobConfig&quot;: { # Configuration for homogeneous migration to Cloud SQL for SQL Server. # Optional. Configuration for SQL Server homogeneous migration.
    &quot;backupFilePattern&quot;: &quot;A String&quot;, # Required. Pattern that describes the default backup naming strategy. The specified pattern should ensure lexicographical order of backups. The pattern must define one of the following capture group sets: Capture group set #1 yy/yyyy - year, 2 or 4 digits mm - month number, 1-12 dd - day of month, 1-31 hh - hour of day, 00-23 mi - minutes, 00-59 ss - seconds, 00-59 Example: For backup file TestDB_20230802_155400.trn, use pattern: (?.*)_backup_(?\d{4})(?\d{2})(?\d{2})_(?\d{2})(?\d{2})(?\d{2}).trn Capture group set #2 timestamp - unix timestamp Example: For backup file TestDB.1691448254.trn, use pattern: (?.*)\.(?\d*).trn or (?.*)\.(?\d*).trn
    &quot;dagConfig&quot;: { # Configuration for distributed availability group (DAG) for the SQL Server homogeneous migration. # Optional. Configuration for distributed availability group (DAG) for the SQL Server homogeneous migration.
      &quot;linkedServer&quot;: &quot;A String&quot;, # Required. The name of the linked server that points to the source SQL Server instance. Only used by DAG migrations.
      &quot;sourceAg&quot;: &quot;A String&quot;, # Required. The name of the source availability group. Only used by DAG migrations.
    },
    &quot;databaseBackups&quot;: [ # Required. Backup details per database in Cloud Storage.
      { # Specifies the backup details for a single database in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server.
        &quot;database&quot;: &quot;A String&quot;, # Required. Name of a SQL Server database for which to define backup configuration.
        &quot;encryptionOptions&quot;: { # Encryption settings for the SQL Server database. # Optional. Encryption settings for the database. Required if provided database backups are encrypted. Encryption settings include path to certificate, path to certificate private key, and key password.
          &quot;certPath&quot;: &quot;A String&quot;, # Required. Path to the Certificate (.cer) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.
          &quot;pvkPassword&quot;: &quot;A String&quot;, # Required. Input only. Password that encrypts the private key.
          &quot;pvkPath&quot;: &quot;A String&quot;, # Required. Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.
        },
      },
    ],
    &quot;promoteWhenReady&quot;: True or False, # Optional. Promote databases when ready.
    &quot;useDiffBackup&quot;: True or False, # Optional. Enable differential backups.
  },
  &quot;sqlserverToPostgresConfig&quot;: { # Configuration for heterogeneous **SQL Server to Cloud SQL for PostgreSQL** migrations. # Configuration for heterogeneous **SQL Server to Cloud SQL for PostgreSQL** migrations.
    &quot;postgresDestinationConfig&quot;: { # Configuration for Postgres as a destination in a migration. # Optional. Configuration for Postgres destination.
      &quot;maxConcurrentConnections&quot;: 42, # Optional. Maximum number of connections Database Migration Service will open to the destination for data migration.
      &quot;transactionTimeout&quot;: &quot;A String&quot;, # Optional. Timeout for data migration transactions.
    },
    &quot;sqlserverSourceConfig&quot;: { # Configuration for SQL Server as a source in a migration. # Optional. Configuration for SQL Server source.
      &quot;cdcStartPosition&quot;: &quot;A String&quot;, # Optional. The log sequence number (LSN) to start CDC data migration from.
      &quot;maxConcurrentCdcConnections&quot;: 42, # Optional. Maximum number of connections Database Migration Service will open to the source for CDC phase.
      &quot;maxConcurrentFullDumpConnections&quot;: 42, # Optional. Maximum number of connections Database Migration Service will open to the source for full dump phase.
      &quot;skipFullDump&quot;: True or False, # Optional. Whether to skip full dump or not.
    },
  },
  &quot;state&quot;: &quot;A String&quot;, # The current migration job state.
  &quot;staticIpConnectivity&quot;: { # The source database will allow incoming connections from the public IP of the destination database. You can retrieve the public IP of the Cloud SQL instance from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required. # static ip connectivity data (default, no additional details needed).
  },
  &quot;type&quot;: &quot;A String&quot;, # Required. The migration job type.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC &quot;Zulu&quot; format, accurate to nanoseconds. Example: &quot;2014-10-02T15:01:23.045123456Z&quot;.
  &quot;vpcPeeringConnectivity&quot;: { # The details of the VPC where the source database is located in Google Cloud. We will use this information to set up the VPC peering connection between Cloud SQL and this VPC. # The details of the VPC network that the source database is located in.
    &quot;vpc&quot;: &quot;A String&quot;, # The name of the VPC network to peer with the Cloud SQL private network.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
  <pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Args:
  resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
  options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:mike@example.com&quot;, &quot;group:admins@example.com&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:eve@example.com&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
  &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { &quot;audit_configs&quot;: [ { &quot;service&quot;: &quot;allServices&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; }, { &quot;log_type&quot;: &quot;ADMIN_READ&quot; } ] }, { &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot; }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot;, &quot;exempted_members&quot;: [ &quot;user:aliya@example.com&quot; ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
      &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
        { # Provides the configuration for logging a type of permissions. Example: { &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; } ] } This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting jose@example.com from DATA_READ logging.
          &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
            &quot;A String&quot;,
          ],
          &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
        },
      ],
      &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
    },
  ],
  &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
    { # Associates `members`, or principals, with a `role`.
      &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
        &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
        &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
        &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
        &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
      },
      &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
        &quot;A String&quot;,
      ],
      &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
    },
  ],
  &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
  &quot;version&quot;: 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists migration jobs in a given project and location.

Args:
  parent: string, Required. The parent which owns this collection of migrationJobs. (required)
  filter: string, A filter expression that filters migration jobs listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, &gt;, or &lt;. For example, list migration jobs created this year by specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z.** You can also filter nested fields. For example, you could specify **reverseSshConnectivity.vmIp = &quot;1.2.3.4&quot;** to select all migration jobs connecting through the specific SSH tunnel bastion.
  orderBy: string, Sort the results based on the migration job name. Valid values are: &quot;name&quot;, &quot;name asc&quot;, and &quot;name desc&quot;.
  pageSize: integer, The maximum number of migration jobs to return. The service may return fewer than this value. If unspecified, at most 50 migration jobs will be returned. The maximum value is 1000; values above 1000 are coerced to 1000.
  pageToken: string, The nextPageToken value received in the previous call to migrationJobs.list, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to migrationJobs.list must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for &#x27;ListMigrationJobs&#x27; request.
  &quot;migrationJobs&quot;: [ # The list of migration jobs objects.
    { # Represents a Database Migration Service migration job object.
      &quot;cmekKeyName&quot;: &quot;A String&quot;, # The CMEK (customer-managed encryption key) fully qualified key name used for the migration job. This field supports all migration jobs types except for: * Mysql to Mysql (use the cmek field in the cloudsql connection profile instead). * PostrgeSQL to PostgreSQL (use the cmek field in the cloudsql connection profile instead). * PostgreSQL to AlloyDB (use the kms_key_name field in the alloydb connection profile instead). Each Cloud CMEK key has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
      &quot;conversionWorkspace&quot;: { # A conversion workspace&#x27;s version. # The conversion workspace used by the migration.
        &quot;commitId&quot;: &quot;A String&quot;, # The commit ID of the conversion workspace.
        &quot;name&quot;: &quot;A String&quot;, # The resource name (URI) of the conversion workspace.
      },
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC &quot;Zulu&quot; format, accurate to nanoseconds. Example: &quot;2014-10-02T15:01:23.045123456Z&quot;.
      &quot;destination&quot;: &quot;A String&quot;, # Required. The resource name (URI) of the destination connection profile.
      &quot;destinationDatabase&quot;: { # A message defining the database engine and provider. # The database engine type and provider of the destination.
        &quot;engine&quot;: &quot;A String&quot;, # The database engine.
        &quot;provider&quot;: &quot;A String&quot;, # The database provider.
      },
      &quot;displayName&quot;: &quot;A String&quot;, # The migration job display name.
      &quot;dumpFlags&quot;: { # Dump flags definition. # The initial dump flags. This field and the &quot;dump_path&quot; field are mutually exclusive.
        &quot;dumpFlags&quot;: [ # The flags for the initial dump.
          { # Dump flag definition.
            &quot;name&quot;: &quot;A String&quot;, # The name of the flag
            &quot;value&quot;: &quot;A String&quot;, # The value of the flag.
          },
        ],
      },
      &quot;dumpPath&quot;: &quot;A String&quot;, # The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). This field and the &quot;dump_flags&quot; field are mutually exclusive.
      &quot;dumpType&quot;: &quot;A String&quot;, # Optional. The type of the data dump. Supported for MySQL to CloudSQL for MySQL migrations only.
      &quot;duration&quot;: &quot;A String&quot;, # Output only. The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by &#x27;s&#x27;. Example: &quot;3.5s&quot;.
      &quot;endTime&quot;: &quot;A String&quot;, # Output only. If the migration job is completed, the time when it was completed.
      &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error details in case of state FAILED.
        &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
        &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
          {
            &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
          },
        ],
        &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      },
      &quot;filter&quot;: &quot;A String&quot;, # This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace.
      &quot;labels&quot;: { # The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of &quot;key&quot;: &quot;value&quot; pairs. Example: `{ &quot;name&quot;: &quot;wrench&quot;, &quot;mass&quot;: &quot;1.3kg&quot;, &quot;count&quot;: &quot;3&quot; }`.
        &quot;a_key&quot;: &quot;A String&quot;,
      },
      &quot;name&quot;: &quot;A String&quot;, # The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
      &quot;objectsConfig&quot;: { # Configuration for the objects to be migrated. # Optional. The objects that need to be migrated.
        &quot;sourceObjectsConfig&quot;: { # List of configurations for the source objects to be migrated. # The list of the migration job objects.
          &quot;objectConfigs&quot;: [ # Optional. The list of the objects to be migrated.
            { # Config for a single migration job object.
              &quot;objectIdentifier&quot;: { # An identifier for the Migration Job Object. # Optional. The object identifier.
                &quot;database&quot;: &quot;A String&quot;, # Optional. The database name. This will be required only if the object uses a database name as part of its unique identifier.
                &quot;schema&quot;: &quot;A String&quot;, # Optional. The schema name. This will be required only if the object uses a schema name as part of its unique identifier.
                &quot;table&quot;: &quot;A String&quot;, # Optional. The table name. This will be required only if the object is a level below database or schema.
                &quot;type&quot;: &quot;A String&quot;, # Required. The type of the migration job object.
              },
            },
          ],
          &quot;objectsSelectionType&quot;: &quot;A String&quot;, # Optional. The objects selection type of the migration job.
        },
      },
      &quot;oracleToPostgresConfig&quot;: { # Configuration for heterogeneous **Oracle to Cloud SQL for PostgreSQL** and **Oracle to AlloyDB for PostgreSQL** migrations. # Configuration for heterogeneous **Oracle to Cloud SQL for PostgreSQL** and **Oracle to AlloyDB for PostgreSQL** migrations.
        &quot;oracleSourceConfig&quot;: { # Configuration for Oracle as a source in a migration. # Optional. Configuration for Oracle source.
          &quot;binaryLogParser&quot;: { # Configuration to use Binary Log Parser CDC technique. # Use Binary Log Parser.
            &quot;logFileDirectories&quot;: { # Configuration to specify the Oracle directories to access the log files. # Use Oracle directories.
              &quot;archivedLogDirectory&quot;: &quot;A String&quot;, # Required. Oracle directory for archived logs.
              &quot;onlineLogDirectory&quot;: &quot;A String&quot;, # Required. Oracle directory for online logs.
            },
            &quot;oracleAsmLogFileAccess&quot;: { # Configuration to use Oracle ASM to access the log files. # Use Oracle ASM.
            },
          },
          &quot;cdcStartPosition&quot;: &quot;A String&quot;, # Optional. The schema change number (SCN) to start CDC data migration from.
          &quot;logMiner&quot;: { # Configuration to use LogMiner CDC method. # Use LogMiner.
          },
          &quot;maxConcurrentCdcConnections&quot;: 42, # Optional. Maximum number of connections Database Migration Service will open to the source for CDC phase.
          &quot;maxConcurrentFullDumpConnections&quot;: 42, # Optional. Maximum number of connections Database Migration Service will open to the source for full dump phase.
          &quot;skipFullDump&quot;: True or False, # Optional. Whether to skip full dump or not.
        },
        &quot;postgresDestinationConfig&quot;: { # Configuration for Postgres as a destination in a migration. # Optional. Configuration for Postgres destination.
          &quot;maxConcurrentConnections&quot;: 42, # Optional. Maximum number of connections Database Migration Service will open to the destination for data migration.
          &quot;transactionTimeout&quot;: &quot;A String&quot;, # Optional. Timeout for data migration transactions.
        },
      },
      &quot;performanceConfig&quot;: { # Performance configuration definition. # Optional. Data dump parallelism settings used by the migration.
        &quot;dumpParallelLevel&quot;: &quot;A String&quot;, # Initial dump parallelism level.
      },
      &quot;phase&quot;: &quot;A String&quot;, # Output only. The current migration job phase.
      &quot;reverseSshConnectivity&quot;: { # The details needed to configure a reverse SSH tunnel between the source and destination databases. These details will be used when calling the generateSshScript method (see https://cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.migrationJobs/generateSshScript) to produce the script that will help set up the reverse SSH tunnel, and to set up the VPC peering between the Cloud SQL private network and the VPC. # The details needed to communicate to the source over Reverse SSH tunnel connectivity.
        &quot;vm&quot;: &quot;A String&quot;, # The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
        &quot;vmIp&quot;: &quot;A String&quot;, # Required. The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
        &quot;vmPort&quot;: 42, # Required. The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
        &quot;vpc&quot;: &quot;A String&quot;, # The name of the VPC to peer with the Cloud SQL private network.
      },
      &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
      &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
      &quot;source&quot;: &quot;A String&quot;, # Required. The resource name (URI) of the source connection profile.
      &quot;sourceDatabase&quot;: { # A message defining the database engine and provider. # The database engine type and provider of the source.
        &quot;engine&quot;: &quot;A String&quot;, # The database engine.
        &quot;provider&quot;: &quot;A String&quot;, # The database provider.
      },
      &quot;sqlserverHomogeneousMigrationJobConfig&quot;: { # Configuration for homogeneous migration to Cloud SQL for SQL Server. # Optional. Configuration for SQL Server homogeneous migration.
        &quot;backupFilePattern&quot;: &quot;A String&quot;, # Required. Pattern that describes the default backup naming strategy. The specified pattern should ensure lexicographical order of backups. The pattern must define one of the following capture group sets: Capture group set #1 yy/yyyy - year, 2 or 4 digits mm - month number, 1-12 dd - day of month, 1-31 hh - hour of day, 00-23 mi - minutes, 00-59 ss - seconds, 00-59 Example: For backup file TestDB_20230802_155400.trn, use pattern: (?.*)_backup_(?\d{4})(?\d{2})(?\d{2})_(?\d{2})(?\d{2})(?\d{2}).trn Capture group set #2 timestamp - unix timestamp Example: For backup file TestDB.1691448254.trn, use pattern: (?.*)\.(?\d*).trn or (?.*)\.(?\d*).trn
        &quot;dagConfig&quot;: { # Configuration for distributed availability group (DAG) for the SQL Server homogeneous migration. # Optional. Configuration for distributed availability group (DAG) for the SQL Server homogeneous migration.
          &quot;linkedServer&quot;: &quot;A String&quot;, # Required. The name of the linked server that points to the source SQL Server instance. Only used by DAG migrations.
          &quot;sourceAg&quot;: &quot;A String&quot;, # Required. The name of the source availability group. Only used by DAG migrations.
        },
        &quot;databaseBackups&quot;: [ # Required. Backup details per database in Cloud Storage.
          { # Specifies the backup details for a single database in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server.
            &quot;database&quot;: &quot;A String&quot;, # Required. Name of a SQL Server database for which to define backup configuration.
            &quot;encryptionOptions&quot;: { # Encryption settings for the SQL Server database. # Optional. Encryption settings for the database. Required if provided database backups are encrypted. Encryption settings include path to certificate, path to certificate private key, and key password.
              &quot;certPath&quot;: &quot;A String&quot;, # Required. Path to the Certificate (.cer) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.
              &quot;pvkPassword&quot;: &quot;A String&quot;, # Required. Input only. Password that encrypts the private key.
              &quot;pvkPath&quot;: &quot;A String&quot;, # Required. Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.
            },
          },
        ],
        &quot;promoteWhenReady&quot;: True or False, # Optional. Promote databases when ready.
        &quot;useDiffBackup&quot;: True or False, # Optional. Enable differential backups.
      },
      &quot;sqlserverToPostgresConfig&quot;: { # Configuration for heterogeneous **SQL Server to Cloud SQL for PostgreSQL** migrations. # Configuration for heterogeneous **SQL Server to Cloud SQL for PostgreSQL** migrations.
        &quot;postgresDestinationConfig&quot;: { # Configuration for Postgres as a destination in a migration. # Optional. Configuration for Postgres destination.
          &quot;maxConcurrentConnections&quot;: 42, # Optional. Maximum number of connections Database Migration Service will open to the destination for data migration.
          &quot;transactionTimeout&quot;: &quot;A String&quot;, # Optional. Timeout for data migration transactions.
        },
        &quot;sqlserverSourceConfig&quot;: { # Configuration for SQL Server as a source in a migration. # Optional. Configuration for SQL Server source.
          &quot;cdcStartPosition&quot;: &quot;A String&quot;, # Optional. The log sequence number (LSN) to start CDC data migration from.
          &quot;maxConcurrentCdcConnections&quot;: 42, # Optional. Maximum number of connections Database Migration Service will open to the source for CDC phase.
          &quot;maxConcurrentFullDumpConnections&quot;: 42, # Optional. Maximum number of connections Database Migration Service will open to the source for full dump phase.
          &quot;skipFullDump&quot;: True or False, # Optional. Whether to skip full dump or not.
        },
      },
      &quot;state&quot;: &quot;A String&quot;, # The current migration job state.
      &quot;staticIpConnectivity&quot;: { # The source database will allow incoming connections from the public IP of the destination database. You can retrieve the public IP of the Cloud SQL instance from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required. # static ip connectivity data (default, no additional details needed).
      },
      &quot;type&quot;: &quot;A String&quot;, # Required. The migration job type.
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC &quot;Zulu&quot; format, accurate to nanoseconds. Example: &quot;2014-10-02T15:01:23.045123456Z&quot;.
      &quot;vpcPeeringConnectivity&quot;: { # The details of the VPC where the source database is located in Google Cloud. We will use this information to set up the VPC peering connection between Cloud SQL and this VPC. # The details of the VPC network that the source database is located in.
        &quot;vpc&quot;: &quot;A String&quot;, # The name of the VPC network to peer with the Cloud SQL private network.
      },
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  &quot;unreachable&quot;: [ # Locations that could not be reached.
    &quot;A String&quot;,
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates the parameters of a single migration job.

Args:
  name: string, The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}. (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents a Database Migration Service migration job object.
  &quot;cmekKeyName&quot;: &quot;A String&quot;, # The CMEK (customer-managed encryption key) fully qualified key name used for the migration job. This field supports all migration jobs types except for: * Mysql to Mysql (use the cmek field in the cloudsql connection profile instead). * PostrgeSQL to PostgreSQL (use the cmek field in the cloudsql connection profile instead). * PostgreSQL to AlloyDB (use the kms_key_name field in the alloydb connection profile instead). Each Cloud CMEK key has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
  &quot;conversionWorkspace&quot;: { # A conversion workspace&#x27;s version. # The conversion workspace used by the migration.
    &quot;commitId&quot;: &quot;A String&quot;, # The commit ID of the conversion workspace.
    &quot;name&quot;: &quot;A String&quot;, # The resource name (URI) of the conversion workspace.
  },
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC &quot;Zulu&quot; format, accurate to nanoseconds. Example: &quot;2014-10-02T15:01:23.045123456Z&quot;.
  &quot;destination&quot;: &quot;A String&quot;, # Required. The resource name (URI) of the destination connection profile.
  &quot;destinationDatabase&quot;: { # A message defining the database engine and provider. # The database engine type and provider of the destination.
    &quot;engine&quot;: &quot;A String&quot;, # The database engine.
    &quot;provider&quot;: &quot;A String&quot;, # The database provider.
  },
  &quot;displayName&quot;: &quot;A String&quot;, # The migration job display name.
  &quot;dumpFlags&quot;: { # Dump flags definition. # The initial dump flags. This field and the &quot;dump_path&quot; field are mutually exclusive.
    &quot;dumpFlags&quot;: [ # The flags for the initial dump.
      { # Dump flag definition.
        &quot;name&quot;: &quot;A String&quot;, # The name of the flag
        &quot;value&quot;: &quot;A String&quot;, # The value of the flag.
      },
    ],
  },
  &quot;dumpPath&quot;: &quot;A String&quot;, # The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). This field and the &quot;dump_flags&quot; field are mutually exclusive.
  &quot;dumpType&quot;: &quot;A String&quot;, # Optional. The type of the data dump. Supported for MySQL to CloudSQL for MySQL migrations only.
  &quot;duration&quot;: &quot;A String&quot;, # Output only. The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by &#x27;s&#x27;. Example: &quot;3.5s&quot;.
  &quot;endTime&quot;: &quot;A String&quot;, # Output only. If the migration job is completed, the time when it was completed.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error details in case of state FAILED.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;filter&quot;: &quot;A String&quot;, # This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace.
  &quot;labels&quot;: { # The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of &quot;key&quot;: &quot;value&quot; pairs. Example: `{ &quot;name&quot;: &quot;wrench&quot;, &quot;mass&quot;: &quot;1.3kg&quot;, &quot;count&quot;: &quot;3&quot; }`.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;name&quot;: &quot;A String&quot;, # The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
  &quot;objectsConfig&quot;: { # Configuration for the objects to be migrated. # Optional. The objects that need to be migrated.
    &quot;sourceObjectsConfig&quot;: { # List of configurations for the source objects to be migrated. # The list of the migration job objects.
      &quot;objectConfigs&quot;: [ # Optional. The list of the objects to be migrated.
        { # Config for a single migration job object.
          &quot;objectIdentifier&quot;: { # An identifier for the Migration Job Object. # Optional. The object identifier.
            &quot;database&quot;: &quot;A String&quot;, # Optional. The database name. This will be required only if the object uses a database name as part of its unique identifier.
            &quot;schema&quot;: &quot;A String&quot;, # Optional. The schema name. This will be required only if the object uses a schema name as part of its unique identifier.
            &quot;table&quot;: &quot;A String&quot;, # Optional. The table name. This will be required only if the object is a level below database or schema.
            &quot;type&quot;: &quot;A String&quot;, # Required. The type of the migration job object.
          },
        },
      ],
      &quot;objectsSelectionType&quot;: &quot;A String&quot;, # Optional. The objects selection type of the migration job.
    },
  },
  &quot;oracleToPostgresConfig&quot;: { # Configuration for heterogeneous **Oracle to Cloud SQL for PostgreSQL** and **Oracle to AlloyDB for PostgreSQL** migrations. # Configuration for heterogeneous **Oracle to Cloud SQL for PostgreSQL** and **Oracle to AlloyDB for PostgreSQL** migrations.
    &quot;oracleSourceConfig&quot;: { # Configuration for Oracle as a source in a migration. # Optional. Configuration for Oracle source.
      &quot;binaryLogParser&quot;: { # Configuration to use Binary Log Parser CDC technique. # Use Binary Log Parser.
        &quot;logFileDirectories&quot;: { # Configuration to specify the Oracle directories to access the log files. # Use Oracle directories.
          &quot;archivedLogDirectory&quot;: &quot;A String&quot;, # Required. Oracle directory for archived logs.
          &quot;onlineLogDirectory&quot;: &quot;A String&quot;, # Required. Oracle directory for online logs.
        },
        &quot;oracleAsmLogFileAccess&quot;: { # Configuration to use Oracle ASM to access the log files. # Use Oracle ASM.
        },
      },
      &quot;cdcStartPosition&quot;: &quot;A String&quot;, # Optional. The schema change number (SCN) to start CDC data migration from.
      &quot;logMiner&quot;: { # Configuration to use LogMiner CDC method. # Use LogMiner.
      },
      &quot;maxConcurrentCdcConnections&quot;: 42, # Optional. Maximum number of connections Database Migration Service will open to the source for CDC phase.
      &quot;maxConcurrentFullDumpConnections&quot;: 42, # Optional. Maximum number of connections Database Migration Service will open to the source for full dump phase.
      &quot;skipFullDump&quot;: True or False, # Optional. Whether to skip full dump or not.
    },
    &quot;postgresDestinationConfig&quot;: { # Configuration for Postgres as a destination in a migration. # Optional. Configuration for Postgres destination.
      &quot;maxConcurrentConnections&quot;: 42, # Optional. Maximum number of connections Database Migration Service will open to the destination for data migration.
      &quot;transactionTimeout&quot;: &quot;A String&quot;, # Optional. Timeout for data migration transactions.
    },
  },
  &quot;performanceConfig&quot;: { # Performance configuration definition. # Optional. Data dump parallelism settings used by the migration.
    &quot;dumpParallelLevel&quot;: &quot;A String&quot;, # Initial dump parallelism level.
  },
  &quot;phase&quot;: &quot;A String&quot;, # Output only. The current migration job phase.
  &quot;reverseSshConnectivity&quot;: { # The details needed to configure a reverse SSH tunnel between the source and destination databases. These details will be used when calling the generateSshScript method (see https://cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.migrationJobs/generateSshScript) to produce the script that will help set up the reverse SSH tunnel, and to set up the VPC peering between the Cloud SQL private network and the VPC. # The details needed to communicate to the source over Reverse SSH tunnel connectivity.
    &quot;vm&quot;: &quot;A String&quot;, # The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
    &quot;vmIp&quot;: &quot;A String&quot;, # Required. The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
    &quot;vmPort&quot;: 42, # Required. The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
    &quot;vpc&quot;: &quot;A String&quot;, # The name of the VPC to peer with the Cloud SQL private network.
  },
  &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
  &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
  &quot;source&quot;: &quot;A String&quot;, # Required. The resource name (URI) of the source connection profile.
  &quot;sourceDatabase&quot;: { # A message defining the database engine and provider. # The database engine type and provider of the source.
    &quot;engine&quot;: &quot;A String&quot;, # The database engine.
    &quot;provider&quot;: &quot;A String&quot;, # The database provider.
  },
  &quot;sqlserverHomogeneousMigrationJobConfig&quot;: { # Configuration for homogeneous migration to Cloud SQL for SQL Server. # Optional. Configuration for SQL Server homogeneous migration.
    &quot;backupFilePattern&quot;: &quot;A String&quot;, # Required. Pattern that describes the default backup naming strategy. The specified pattern should ensure lexicographical order of backups. The pattern must define one of the following capture group sets: Capture group set #1 yy/yyyy - year, 2 or 4 digits mm - month number, 1-12 dd - day of month, 1-31 hh - hour of day, 00-23 mi - minutes, 00-59 ss - seconds, 00-59 Example: For backup file TestDB_20230802_155400.trn, use pattern: (?.*)_backup_(?\d{4})(?\d{2})(?\d{2})_(?\d{2})(?\d{2})(?\d{2}).trn Capture group set #2 timestamp - unix timestamp Example: For backup file TestDB.1691448254.trn, use pattern: (?.*)\.(?\d*).trn or (?.*)\.(?\d*).trn
    &quot;dagConfig&quot;: { # Configuration for distributed availability group (DAG) for the SQL Server homogeneous migration. # Optional. Configuration for distributed availability group (DAG) for the SQL Server homogeneous migration.
      &quot;linkedServer&quot;: &quot;A String&quot;, # Required. The name of the linked server that points to the source SQL Server instance. Only used by DAG migrations.
      &quot;sourceAg&quot;: &quot;A String&quot;, # Required. The name of the source availability group. Only used by DAG migrations.
    },
    &quot;databaseBackups&quot;: [ # Required. Backup details per database in Cloud Storage.
      { # Specifies the backup details for a single database in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server.
        &quot;database&quot;: &quot;A String&quot;, # Required. Name of a SQL Server database for which to define backup configuration.
        &quot;encryptionOptions&quot;: { # Encryption settings for the SQL Server database. # Optional. Encryption settings for the database. Required if provided database backups are encrypted. Encryption settings include path to certificate, path to certificate private key, and key password.
          &quot;certPath&quot;: &quot;A String&quot;, # Required. Path to the Certificate (.cer) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.
          &quot;pvkPassword&quot;: &quot;A String&quot;, # Required. Input only. Password that encrypts the private key.
          &quot;pvkPath&quot;: &quot;A String&quot;, # Required. Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.
        },
      },
    ],
    &quot;promoteWhenReady&quot;: True or False, # Optional. Promote databases when ready.
    &quot;useDiffBackup&quot;: True or False, # Optional. Enable differential backups.
  },
  &quot;sqlserverToPostgresConfig&quot;: { # Configuration for heterogeneous **SQL Server to Cloud SQL for PostgreSQL** migrations. # Configuration for heterogeneous **SQL Server to Cloud SQL for PostgreSQL** migrations.
    &quot;postgresDestinationConfig&quot;: { # Configuration for Postgres as a destination in a migration. # Optional. Configuration for Postgres destination.
      &quot;maxConcurrentConnections&quot;: 42, # Optional. Maximum number of connections Database Migration Service will open to the destination for data migration.
      &quot;transactionTimeout&quot;: &quot;A String&quot;, # Optional. Timeout for data migration transactions.
    },
    &quot;sqlserverSourceConfig&quot;: { # Configuration for SQL Server as a source in a migration. # Optional. Configuration for SQL Server source.
      &quot;cdcStartPosition&quot;: &quot;A String&quot;, # Optional. The log sequence number (LSN) to start CDC data migration from.
      &quot;maxConcurrentCdcConnections&quot;: 42, # Optional. Maximum number of connections Database Migration Service will open to the source for CDC phase.
      &quot;maxConcurrentFullDumpConnections&quot;: 42, # Optional. Maximum number of connections Database Migration Service will open to the source for full dump phase.
      &quot;skipFullDump&quot;: True or False, # Optional. Whether to skip full dump or not.
    },
  },
  &quot;state&quot;: &quot;A String&quot;, # The current migration job state.
  &quot;staticIpConnectivity&quot;: { # The source database will allow incoming connections from the public IP of the destination database. You can retrieve the public IP of the Cloud SQL instance from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required. # static ip connectivity data (default, no additional details needed).
  },
  &quot;type&quot;: &quot;A String&quot;, # Required. The migration job type.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC &quot;Zulu&quot; format, accurate to nanoseconds. Example: &quot;2014-10-02T15:01:23.045123456Z&quot;.
  &quot;vpcPeeringConnectivity&quot;: { # The details of the VPC where the source database is located in Google Cloud. We will use this information to set up the VPC peering connection between Cloud SQL and this VPC. # The details of the VPC network that the source database is located in.
    &quot;vpc&quot;: &quot;A String&quot;, # The name of the VPC network to peer with the Cloud SQL private network.
  },
}

  requestId: string, A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
  updateMask: string, Required. Field mask is used to specify the fields to be overwritten by the update in the conversion workspace resource.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="promote">promote(name, body=None, x__xgafv=None)</code>
  <pre>Promote a migration job, stopping replication to the destination and promoting the destination to be a standalone database.

Args:
  name: string, Name of the migration job resource to promote. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for &#x27;PromoteMigrationJob&#x27; request.
  &quot;objectsFilter&quot;: { # Configuration for the objects to be migrated. # Optional. The object filter to apply to the migration job.
    &quot;sourceObjectsConfig&quot;: { # List of configurations for the source objects to be migrated. # The list of the migration job objects.
      &quot;objectConfigs&quot;: [ # Optional. The list of the objects to be migrated.
        { # Config for a single migration job object.
          &quot;objectIdentifier&quot;: { # An identifier for the Migration Job Object. # Optional. The object identifier.
            &quot;database&quot;: &quot;A String&quot;, # Optional. The database name. This will be required only if the object uses a database name as part of its unique identifier.
            &quot;schema&quot;: &quot;A String&quot;, # Optional. The schema name. This will be required only if the object uses a schema name as part of its unique identifier.
            &quot;table&quot;: &quot;A String&quot;, # Optional. The table name. This will be required only if the object is a level below database or schema.
            &quot;type&quot;: &quot;A String&quot;, # Required. The type of the migration job object.
          },
        },
      ],
      &quot;objectsSelectionType&quot;: &quot;A String&quot;, # Optional. The objects selection type of the migration job.
    },
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="restart">restart(name, body=None, x__xgafv=None)</code>
  <pre>Restart a stopped or failed migration job, resetting the destination instance to its original state and starting the migration process from scratch.

Args:
  name: string, Name of the migration job resource to restart. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for &#x27;RestartMigrationJob&#x27; request.
  &quot;objectsFilter&quot;: { # Configuration for the objects to be migrated. # Optional. The object filter to apply to the migration job.
    &quot;sourceObjectsConfig&quot;: { # List of configurations for the source objects to be migrated. # The list of the migration job objects.
      &quot;objectConfigs&quot;: [ # Optional. The list of the objects to be migrated.
        { # Config for a single migration job object.
          &quot;objectIdentifier&quot;: { # An identifier for the Migration Job Object. # Optional. The object identifier.
            &quot;database&quot;: &quot;A String&quot;, # Optional. The database name. This will be required only if the object uses a database name as part of its unique identifier.
            &quot;schema&quot;: &quot;A String&quot;, # Optional. The schema name. This will be required only if the object uses a schema name as part of its unique identifier.
            &quot;table&quot;: &quot;A String&quot;, # Optional. The table name. This will be required only if the object is a level below database or schema.
            &quot;type&quot;: &quot;A String&quot;, # Required. The type of the migration job object.
          },
        },
      ],
      &quot;objectsSelectionType&quot;: &quot;A String&quot;, # Optional. The objects selection type of the migration job.
    },
  },
  &quot;restartFailedObjects&quot;: True or False, # Optional. If true, only failed objects will be restarted.
  &quot;skipValidation&quot;: True or False, # Optional. Restart the migration job without running prior configuration verification. Defaults to `false`.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="resume">resume(name, body=None, x__xgafv=None)</code>
  <pre>Resume a migration job that is currently stopped and is resumable (was stopped during CDC phase).

Args:
  name: string, Name of the migration job resource to resume. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for &#x27;ResumeMigrationJob&#x27; request.
  &quot;skipValidation&quot;: True or False, # Optional. Resume the migration job without running prior configuration verification. Defaults to `false`.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
  <pre>Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

Args:
  resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for `SetIamPolicy` method.
  &quot;policy&quot;: { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:mike@example.com&quot;, &quot;group:admins@example.com&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:eve@example.com&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
    &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
      { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { &quot;audit_configs&quot;: [ { &quot;service&quot;: &quot;allServices&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; }, { &quot;log_type&quot;: &quot;ADMIN_READ&quot; } ] }, { &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot; }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot;, &quot;exempted_members&quot;: [ &quot;user:aliya@example.com&quot; ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
        &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
          { # Provides the configuration for logging a type of permissions. Example: { &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; } ] } This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting jose@example.com from DATA_READ logging.
            &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
              &quot;A String&quot;,
            ],
            &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
          },
        ],
        &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
      },
    ],
    &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
      { # Associates `members`, or principals, with a `role`.
        &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
          &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
          &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
          &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
          &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
        },
        &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
          &quot;A String&quot;,
        ],
        &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
      },
    ],
    &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
    &quot;version&quot;: 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
  },
  &quot;updateMask&quot;: &quot;A String&quot;, # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: &quot;bindings, etag&quot;`
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:mike@example.com&quot;, &quot;group:admins@example.com&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:eve@example.com&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
  &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { &quot;audit_configs&quot;: [ { &quot;service&quot;: &quot;allServices&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; }, { &quot;log_type&quot;: &quot;ADMIN_READ&quot; } ] }, { &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot; }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot;, &quot;exempted_members&quot;: [ &quot;user:aliya@example.com&quot; ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
      &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
        { # Provides the configuration for logging a type of permissions. Example: { &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; } ] } This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting jose@example.com from DATA_READ logging.
          &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
            &quot;A String&quot;,
          ],
          &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
        },
      ],
      &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
    },
  ],
  &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
    { # Associates `members`, or principals, with a `role`.
      &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
        &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
        &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
        &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
        &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
      },
      &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
        &quot;A String&quot;,
      ],
      &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
    },
  ],
  &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
  &quot;version&quot;: 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}</pre>
</div>

<div class="method">
    <code class="details" id="start">start(name, body=None, x__xgafv=None)</code>
  <pre>Start an already created migration job.

Args:
  name: string, Name of the migration job resource to start. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for &#x27;StartMigrationJob&#x27; request.
  &quot;skipValidation&quot;: True or False, # Optional. Start the migration job without running prior configuration verification. Defaults to `false`.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="stop">stop(name, body=None, x__xgafv=None)</code>
  <pre>Stops a running migration job.

Args:
  name: string, Name of the migration job resource to stop. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for &#x27;StopMigrationJob&#x27; request.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
  <pre>Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may &quot;fail open&quot; without warning.

Args:
  resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for `TestIamPermissions` method.
  &quot;permissions&quot;: [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
    &quot;A String&quot;,
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for `TestIamPermissions` method.
  &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
    &quot;A String&quot;,
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="verify">verify(name, body=None, x__xgafv=None)</code>
  <pre>Verify a migration job, making sure the destination can reach the source and that all configuration and prerequisites are met.

Args:
  name: string, Name of the migration job resource to verify. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for &#x27;VerifyMigrationJob&#x27; request.
  &quot;migrationJob&quot;: { # Represents a Database Migration Service migration job object. # Optional. The changed migration job parameters to verify. It will not update the migration job.
    &quot;cmekKeyName&quot;: &quot;A String&quot;, # The CMEK (customer-managed encryption key) fully qualified key name used for the migration job. This field supports all migration jobs types except for: * Mysql to Mysql (use the cmek field in the cloudsql connection profile instead). * PostrgeSQL to PostgreSQL (use the cmek field in the cloudsql connection profile instead). * PostgreSQL to AlloyDB (use the kms_key_name field in the alloydb connection profile instead). Each Cloud CMEK key has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
    &quot;conversionWorkspace&quot;: { # A conversion workspace&#x27;s version. # The conversion workspace used by the migration.
      &quot;commitId&quot;: &quot;A String&quot;, # The commit ID of the conversion workspace.
      &quot;name&quot;: &quot;A String&quot;, # The resource name (URI) of the conversion workspace.
    },
    &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC &quot;Zulu&quot; format, accurate to nanoseconds. Example: &quot;2014-10-02T15:01:23.045123456Z&quot;.
    &quot;destination&quot;: &quot;A String&quot;, # Required. The resource name (URI) of the destination connection profile.
    &quot;destinationDatabase&quot;: { # A message defining the database engine and provider. # The database engine type and provider of the destination.
      &quot;engine&quot;: &quot;A String&quot;, # The database engine.
      &quot;provider&quot;: &quot;A String&quot;, # The database provider.
    },
    &quot;displayName&quot;: &quot;A String&quot;, # The migration job display name.
    &quot;dumpFlags&quot;: { # Dump flags definition. # The initial dump flags. This field and the &quot;dump_path&quot; field are mutually exclusive.
      &quot;dumpFlags&quot;: [ # The flags for the initial dump.
        { # Dump flag definition.
          &quot;name&quot;: &quot;A String&quot;, # The name of the flag
          &quot;value&quot;: &quot;A String&quot;, # The value of the flag.
        },
      ],
    },
    &quot;dumpPath&quot;: &quot;A String&quot;, # The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). This field and the &quot;dump_flags&quot; field are mutually exclusive.
    &quot;dumpType&quot;: &quot;A String&quot;, # Optional. The type of the data dump. Supported for MySQL to CloudSQL for MySQL migrations only.
    &quot;duration&quot;: &quot;A String&quot;, # Output only. The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by &#x27;s&#x27;. Example: &quot;3.5s&quot;.
    &quot;endTime&quot;: &quot;A String&quot;, # Output only. If the migration job is completed, the time when it was completed.
    &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error details in case of state FAILED.
      &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
      &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
        {
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
        },
      ],
      &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    },
    &quot;filter&quot;: &quot;A String&quot;, # This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace.
    &quot;labels&quot;: { # The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of &quot;key&quot;: &quot;value&quot; pairs. Example: `{ &quot;name&quot;: &quot;wrench&quot;, &quot;mass&quot;: &quot;1.3kg&quot;, &quot;count&quot;: &quot;3&quot; }`.
      &quot;a_key&quot;: &quot;A String&quot;,
    },
    &quot;name&quot;: &quot;A String&quot;, # The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
    &quot;objectsConfig&quot;: { # Configuration for the objects to be migrated. # Optional. The objects that need to be migrated.
      &quot;sourceObjectsConfig&quot;: { # List of configurations for the source objects to be migrated. # The list of the migration job objects.
        &quot;objectConfigs&quot;: [ # Optional. The list of the objects to be migrated.
          { # Config for a single migration job object.
            &quot;objectIdentifier&quot;: { # An identifier for the Migration Job Object. # Optional. The object identifier.
              &quot;database&quot;: &quot;A String&quot;, # Optional. The database name. This will be required only if the object uses a database name as part of its unique identifier.
              &quot;schema&quot;: &quot;A String&quot;, # Optional. The schema name. This will be required only if the object uses a schema name as part of its unique identifier.
              &quot;table&quot;: &quot;A String&quot;, # Optional. The table name. This will be required only if the object is a level below database or schema.
              &quot;type&quot;: &quot;A String&quot;, # Required. The type of the migration job object.
            },
          },
        ],
        &quot;objectsSelectionType&quot;: &quot;A String&quot;, # Optional. The objects selection type of the migration job.
      },
    },
    &quot;oracleToPostgresConfig&quot;: { # Configuration for heterogeneous **Oracle to Cloud SQL for PostgreSQL** and **Oracle to AlloyDB for PostgreSQL** migrations. # Configuration for heterogeneous **Oracle to Cloud SQL for PostgreSQL** and **Oracle to AlloyDB for PostgreSQL** migrations.
      &quot;oracleSourceConfig&quot;: { # Configuration for Oracle as a source in a migration. # Optional. Configuration for Oracle source.
        &quot;binaryLogParser&quot;: { # Configuration to use Binary Log Parser CDC technique. # Use Binary Log Parser.
          &quot;logFileDirectories&quot;: { # Configuration to specify the Oracle directories to access the log files. # Use Oracle directories.
            &quot;archivedLogDirectory&quot;: &quot;A String&quot;, # Required. Oracle directory for archived logs.
            &quot;onlineLogDirectory&quot;: &quot;A String&quot;, # Required. Oracle directory for online logs.
          },
          &quot;oracleAsmLogFileAccess&quot;: { # Configuration to use Oracle ASM to access the log files. # Use Oracle ASM.
          },
        },
        &quot;cdcStartPosition&quot;: &quot;A String&quot;, # Optional. The schema change number (SCN) to start CDC data migration from.
        &quot;logMiner&quot;: { # Configuration to use LogMiner CDC method. # Use LogMiner.
        },
        &quot;maxConcurrentCdcConnections&quot;: 42, # Optional. Maximum number of connections Database Migration Service will open to the source for CDC phase.
        &quot;maxConcurrentFullDumpConnections&quot;: 42, # Optional. Maximum number of connections Database Migration Service will open to the source for full dump phase.
        &quot;skipFullDump&quot;: True or False, # Optional. Whether to skip full dump or not.
      },
      &quot;postgresDestinationConfig&quot;: { # Configuration for Postgres as a destination in a migration. # Optional. Configuration for Postgres destination.
        &quot;maxConcurrentConnections&quot;: 42, # Optional. Maximum number of connections Database Migration Service will open to the destination for data migration.
        &quot;transactionTimeout&quot;: &quot;A String&quot;, # Optional. Timeout for data migration transactions.
      },
    },
    &quot;performanceConfig&quot;: { # Performance configuration definition. # Optional. Data dump parallelism settings used by the migration.
      &quot;dumpParallelLevel&quot;: &quot;A String&quot;, # Initial dump parallelism level.
    },
    &quot;phase&quot;: &quot;A String&quot;, # Output only. The current migration job phase.
    &quot;reverseSshConnectivity&quot;: { # The details needed to configure a reverse SSH tunnel between the source and destination databases. These details will be used when calling the generateSshScript method (see https://cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.migrationJobs/generateSshScript) to produce the script that will help set up the reverse SSH tunnel, and to set up the VPC peering between the Cloud SQL private network and the VPC. # The details needed to communicate to the source over Reverse SSH tunnel connectivity.
      &quot;vm&quot;: &quot;A String&quot;, # The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
      &quot;vmIp&quot;: &quot;A String&quot;, # Required. The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
      &quot;vmPort&quot;: 42, # Required. The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
      &quot;vpc&quot;: &quot;A String&quot;, # The name of the VPC to peer with the Cloud SQL private network.
    },
    &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
    &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
    &quot;source&quot;: &quot;A String&quot;, # Required. The resource name (URI) of the source connection profile.
    &quot;sourceDatabase&quot;: { # A message defining the database engine and provider. # The database engine type and provider of the source.
      &quot;engine&quot;: &quot;A String&quot;, # The database engine.
      &quot;provider&quot;: &quot;A String&quot;, # The database provider.
    },
    &quot;sqlserverHomogeneousMigrationJobConfig&quot;: { # Configuration for homogeneous migration to Cloud SQL for SQL Server. # Optional. Configuration for SQL Server homogeneous migration.
      &quot;backupFilePattern&quot;: &quot;A String&quot;, # Required. Pattern that describes the default backup naming strategy. The specified pattern should ensure lexicographical order of backups. The pattern must define one of the following capture group sets: Capture group set #1 yy/yyyy - year, 2 or 4 digits mm - month number, 1-12 dd - day of month, 1-31 hh - hour of day, 00-23 mi - minutes, 00-59 ss - seconds, 00-59 Example: For backup file TestDB_20230802_155400.trn, use pattern: (?.*)_backup_(?\d{4})(?\d{2})(?\d{2})_(?\d{2})(?\d{2})(?\d{2}).trn Capture group set #2 timestamp - unix timestamp Example: For backup file TestDB.1691448254.trn, use pattern: (?.*)\.(?\d*).trn or (?.*)\.(?\d*).trn
      &quot;dagConfig&quot;: { # Configuration for distributed availability group (DAG) for the SQL Server homogeneous migration. # Optional. Configuration for distributed availability group (DAG) for the SQL Server homogeneous migration.
        &quot;linkedServer&quot;: &quot;A String&quot;, # Required. The name of the linked server that points to the source SQL Server instance. Only used by DAG migrations.
        &quot;sourceAg&quot;: &quot;A String&quot;, # Required. The name of the source availability group. Only used by DAG migrations.
      },
      &quot;databaseBackups&quot;: [ # Required. Backup details per database in Cloud Storage.
        { # Specifies the backup details for a single database in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server.
          &quot;database&quot;: &quot;A String&quot;, # Required. Name of a SQL Server database for which to define backup configuration.
          &quot;encryptionOptions&quot;: { # Encryption settings for the SQL Server database. # Optional. Encryption settings for the database. Required if provided database backups are encrypted. Encryption settings include path to certificate, path to certificate private key, and key password.
            &quot;certPath&quot;: &quot;A String&quot;, # Required. Path to the Certificate (.cer) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.
            &quot;pvkPassword&quot;: &quot;A String&quot;, # Required. Input only. Password that encrypts the private key.
            &quot;pvkPath&quot;: &quot;A String&quot;, # Required. Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.
          },
        },
      ],
      &quot;promoteWhenReady&quot;: True or False, # Optional. Promote databases when ready.
      &quot;useDiffBackup&quot;: True or False, # Optional. Enable differential backups.
    },
    &quot;sqlserverToPostgresConfig&quot;: { # Configuration for heterogeneous **SQL Server to Cloud SQL for PostgreSQL** migrations. # Configuration for heterogeneous **SQL Server to Cloud SQL for PostgreSQL** migrations.
      &quot;postgresDestinationConfig&quot;: { # Configuration for Postgres as a destination in a migration. # Optional. Configuration for Postgres destination.
        &quot;maxConcurrentConnections&quot;: 42, # Optional. Maximum number of connections Database Migration Service will open to the destination for data migration.
        &quot;transactionTimeout&quot;: &quot;A String&quot;, # Optional. Timeout for data migration transactions.
      },
      &quot;sqlserverSourceConfig&quot;: { # Configuration for SQL Server as a source in a migration. # Optional. Configuration for SQL Server source.
        &quot;cdcStartPosition&quot;: &quot;A String&quot;, # Optional. The log sequence number (LSN) to start CDC data migration from.
        &quot;maxConcurrentCdcConnections&quot;: 42, # Optional. Maximum number of connections Database Migration Service will open to the source for CDC phase.
        &quot;maxConcurrentFullDumpConnections&quot;: 42, # Optional. Maximum number of connections Database Migration Service will open to the source for full dump phase.
        &quot;skipFullDump&quot;: True or False, # Optional. Whether to skip full dump or not.
      },
    },
    &quot;state&quot;: &quot;A String&quot;, # The current migration job state.
    &quot;staticIpConnectivity&quot;: { # The source database will allow incoming connections from the public IP of the destination database. You can retrieve the public IP of the Cloud SQL instance from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required. # static ip connectivity data (default, no additional details needed).
    },
    &quot;type&quot;: &quot;A String&quot;, # Required. The migration job type.
    &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC &quot;Zulu&quot; format, accurate to nanoseconds. Example: &quot;2014-10-02T15:01:23.045123456Z&quot;.
    &quot;vpcPeeringConnectivity&quot;: { # The details of the VPC where the source database is located in Google Cloud. We will use this information to set up the VPC peering connection between Cloud SQL and this VPC. # The details of the VPC network that the source database is located in.
      &quot;vpc&quot;: &quot;A String&quot;, # The name of the VPC network to peer with the Cloud SQL private network.
    },
  },
  &quot;updateMask&quot;: &quot;A String&quot;, # Optional. Field mask is used to specify the changed fields to be verified. It will not update the migration job.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

</body></html>